//--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
// Copyright 2012 Microsoft Corporation. All Rights Reserved
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.   
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
//--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

namespace Preflight
{
    using System.Collections.Generic;
    using Model;

    /// <summary>
    /// Verification Factory
    /// </summary>
    /// <remarks>
    /// This is the main pluggable interface into Preflight. It enables your application to feed 
    /// application details as well as verifications to run.
    /// </remarks>
    public interface IVerificationFactory
    {
        /// <summary>
        /// Gets Application description
        /// </summary>
        ApplicationDescription ApplicationDescription { get; }

        /// <summary>
        /// Gets verifications to execute.
        /// </summary>
        /// <remarks>
        /// Note that Preflight will only call this method once unless it is reintialized.
        /// It is important that your verifications do not maintain state other than static configuration
        /// so that they are rerunnable.
        /// </remarks>
        /// <returns>Verifications</returns>
        IEnumerable<IVerification> GetVerifications();
    }
}